###########################################################################
#                                 Content                                 #
###########################################################################
/** @mainpage tinyVT documentation
 * @image html tinyvt_rbp_far.jpg "tinyVT on Raspberry Pi"
 * */

/** @defgroup hardware hardware
 * @brief tinyVT hardware */

/** @defgroup code code
 * @brief code of the project */

###########################################################################
#                                  Code                                   #
###########################################################################
/** @defgroup firmware firmware
 * @ingroup code
 * @brief tinyVT firmware */

/** @defgroup terminfo terminfo
 * @ingroup code
 * @include tinyvt.info
 * @brief tinyVT terminfo entry */

/** @defgroup client client
 * @ingroup code
 * @brief PLANNED client library */

###########################################################################
#                                Firmware                                 #
###########################################################################
/** @defgroup keyboard PS/2 keyboard
 * @ingroup firmware
 * @brief functions to interface a PS/2 keyboard
 *
 * @author cameris camerisdump@gmail.com */

/** @defgroup lcd LCD
 * @ingroup firmware
 * @brief basic functions to interface SSD1289 controller and PWM driven
 * backlight
 *
 * @author cameris camerisdump@gmail.com */

/** @defgroup uart UART
 * @ingroup firmware
 * @brief functions to handle UART input/output and flowcontrol
 *
 * @author cameris camerisdump@gmail.com */

/** @defgroup profile Profile
 * @ingroup firmware
 * @brief save/load user profiles in/from EEPROM
 *
 * @author cameris camerisdump@gmail.com */

/** @defgroup vtparser VT Parser
 * @ingroup firmware
 * @brief state machine parser
 *
 * an implementation of [Paul Williams' DEC compatible state machine
 * parser](http://www.vt100.net/emu/dec_ansi_parser) written by Joshua Haberman
 *
 * @author Joshua Haberman <joshua@reverberate.org>
 * @author _modified by_ cameris <camerisdump@gmail.com> */

/** @defgroup processing Processing
 * @ingroup firmware
 * @brief proccessing input and output
 *
 * @author cameris camerisdump@gmail.com */

/** @defgroup terminal Terminal
 * @ingroup firmware
 * @brief screen buffer and functions to manipulate it
 *
 * @author cameris camerisdump@gmail.com */

###########################################################################
#                                Hardware                                 #
###########################################################################
/** @defgroup schematic Schematic
 * @ingroup hardware
 *
 * @brief schematic
 * @image html tinyvt_schematic_1.svg "schematic (main)"
 * <br/>
 * @image html tinyvt_schematic_2.svg "schematic (stepdown)"
 */

/** @defgroup pcb PCB Layout
 * @ingroup hardware
 *
 * @brief layout of the PCB
 * @image html tinyvt_layout_front.svg "layout (front)"
 * <br/>
 * @image html tinyvt_layout_back.svg "layout (back)"
 * */

/** @defgroup bom BOM
 * @ingroup hardware
 * @brief Bill of Materials
 *
Reference	|	Value		|	Reichelt part number				|	Comments
---------	|	-----		|	--------------------				|   --------
C1			|	100n		|	X7R-G0805 100N						|	|
C2			|	15p			|	NPO-G0805 15P						|	|
C3			|	15p			|	NPO-G0805 15P						|	|
C4			|	100n		|	X7R-G0805 100N						|	|
C5			|	100n		|	X7R-G0805 100N						|	|
C6			|	100n		|	X7R-G0805 100N						|	|
C7			|	100n		|	X7R-G0805 100N						|	|
C8			|	100n		|	X7R-G0805 100N						|	|
C9			|	100n		|	X7R-G0805 100N						|	|
C10			|	100n		|	X7R-G0805 100N						|	|
C11			|	22µ			|	X5R-G1210 22						|	|
C12			|	100n		|	X7R-G0805 100N						|	|
C13			|	100n		|	X7R-G0805 100N						|	|
C14			|	3,3n		|	X7R-G0805 3,3N						|	|
C15			|	100n		|	X7R-G0805 100N						|	|
C16			|	47µ			|	X5R-G1206 47/6						|	|
C17			|	47µ			|	X5R-G1206 47/6						|	|
C18			|	100n		|	X7R-G0805 100N						|	|
D1			|	MBRS140		|	MBRS 140 SMD						|	|
D2			|	1N4148		|	1N 4148 SMD							|	|
IC1			|	ATMEGA-1284	|	ATMEGA 1284P-AU						|	|
IC2			|	LT1376		|	LT 1376 CS8-5						|	|
J1			|	DC-SOCKET	|	HEBW 25								|	|
J2			|	ISP			|	WSL 6G								|	|
J3			|	PS/2		|	USB AW								|	|
J4			|	TTL			|	MEBP 8-8G							|	|
JP1			|	JP_VCC		|	MPE 149-2-002-F3					|	|
JP2			|	JP_VIN		|	MPE 149-2-002-F1					|	|
JP3			|	JP_GND		|	SL 1X40G 2,54\n MPE 149-2-002-F0 	|	|
L1			|	ferrit		|	BLM21PG 600							|	|
L2			|	33µ			|	L-PIS4720 33µ						|	|
LS1			|	BUZZER		|	SUMMER EPM 121						|	|
P1			|	HY32D		|	BL 2X17G8 2,54\n 4 x DA 10MM		|	LCD module: ebay, wvshare.com
R1			|	10k			|	SMD-0805 10,0K						|	|
R2			|	15k			|	SMD-0805 15,0K						|	|
S1			|	KBD_RESET	|	TASTER 3301							|	|
U1			|	ADUM1201	|	ADUM 1201 AR						|	|
X1			|	20MHz		|	20,00000-MJ							|	|
-			|	-			|	SK M3\n 4 x DA 18MM					|	mounting
 */

/* vim:set filetype=c: */
